<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class IQuery</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface IQuery</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents a query that can be submitted to the search engine.</p>
<p class="description"><p>This includes both the actual query string and all search parameters  that should be used.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: IQuery.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---query---IQuery.php.html">/src/sde/fastsearch/query/IQuery.php</a> (line <span class="field">32</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																						
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addFilterTerm" title="details" class="method-name">addFilterTerm</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$term</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result"><a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a></span>
										<a href="#getParameterByName" title="details" class="method-name">getParameterByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$paramName</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getParameterByType" title="details" class="method-name">getParameterByType</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$paramType</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getQueryString" title="details" class="method-name">getQueryString</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getSearchParameters" title="details" class="method-name">getSearchParameters</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setParameter" title="details" class="method-name">setParameter</a>
											(<span class="var-type"><a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a></span>&nbsp;<span class="var-name">$param</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setParameterByName" title="details" class="method-name">setParameterByName</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$paramName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setParameterByType" title="details" class="method-name">setParameterByType</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$paramType</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setQueryString" title="details" class="method-name">setQueryString</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$queryString</span>)
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodaddFilterTerm" id="addFilterTerm"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addFilterTerm</span> (line <span class="line-number">105</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a term to the filter parameter in this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addFilterTerm
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$term</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$term</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetParameterByName" id="getParameterByName"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getParameterByName</span> (line <span class="line-number">89</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the search parameter with given name. If no such parameter exists  a <a href="../sde_fastsearch_query/NoSuchParameterException.html">NoSuchParameterException</a> is thrown.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> <a href="../sde_fastsearch_query/NoSuchParameterException.html">NoSuchParameterException</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a></span>
		<span class="method-name">
			getParameterByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$paramName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$paramName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetParameterByType" id="getParameterByType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getParameterByType</span> (line <span class="line-number">98</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the search parameter of the given type. If no such parameter exists  a <a href="../sde_fastsearch_query/NoSuchParameterException.html">NoSuchParameterException</a> is thrown.</p>
	<ul class="tags">
				<li><span class="field">throws:</span> <a href="../sde_fastsearch_query/NoSuchParameterException.html">NoSuchParameterException</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getParameterByType
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$paramType</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$paramType</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetQueryString" id="getQueryString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getQueryString</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the query string of this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getQueryString
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSearchParameters" id="getSearchParameters"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSearchParameters</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns all search parameters in this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getSearchParameters
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetParameter" id="setParameter"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setParameter</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the given <a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a> for this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setParameter
		</span>
					(<span class="var-type"><a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a></span>&nbsp;<span class="var-name">$param</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../sde_fastsearch_query/SearchParameter.html">SearchParameter</a></span>
				<span class="var-name">$param</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetParameterByName" id="setParameterByName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setParameterByName</span> (line <span class="line-number">72</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the value of the parameter with the given parameter name  for this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setParameterByName
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$paramName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$paramName</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetParameterByType" id="setParameterByType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setParameterByType</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the value of the parameter represented by the given parameter  type for this query. The given parameter type should be a valid  type defined in <a href="../sde_fastsearch_query/BaseParameter.html">BaseParameter</a>.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../sde_fastsearch_query/BaseParameter.html">BaseParameter</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setParameterByType
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$paramType</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$paramType</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetQueryString" id="setQueryString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setQueryString</span> (line <span class="line-number">38</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the query string of this query.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setQueryString
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$queryString</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$queryString</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:08 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>